API docs by Redocly

Nudm_SDM (2.3.3)

Download OpenAPI specification:

Nudm Subscriber Data Management Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.503 Unified Data Management Services, version 18.9.0

Retrieval of multiple data sets

retrieve multiple data sets

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
required
Array of strings or strings (DatasetNames) >= 2 items unique

List of dataset names

object (PlmnIdNid)

serving PLMN ID or SNPN ID

Array of objects (PlmnId) non-empty

List of PLMNs adjacent to the UE's serving PLMN

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

string or string (UcPurpose)

User consent purpose

disaster-roaming-ind
boolean
Default: false

Indication whether Disaster Roaming service is applied or not

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "amData": {
    },
  • "smfSelData": {
    },
  • "uecAmfData": {
    },
  • "uecSmfData": {
    },
  • "uecSmsfData": {
    },
  • "smsSubsData": {
    },
  • "smData": [
    ],
  • "traceData": {
    },
  • "smsMngData": {
    },
  • "lcsPrivacyData": {
    },
  • "lcsMoData": {
    },
  • "lcsSubscriptionData": {
    },
  • "v2xData": {
    },
  • "lcsBroadcastAssistanceTypesData": {
    },
  • "proseData": {
    },
  • "mbsData": {
    },
  • "ucData": {
    },
  • "a2xData": {
    },
  • "rangingSlPrivacyData": {
    }
}

Slice Selection Subscription Data Retrieval

retrieve a UE's subscribed NSSAI

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

serving PLMN ID or SNPN ID

disaster-roaming-ind
boolean
Default: false

Indication whether Disaster Roaming service is applied or not

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "defaultSingleNssais": [
    ],
  • "singleNssais": [
    ],
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "additionalSnssaiData": {
    },
  • "suppressNssrgInd": true,
  • "nssaiValidityTimeInfo": {
    }
}

UE Context In AMF Data Retrieval

retrieve a UE's UE Context In AMF Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "epsInterworkingInfo": {
    },
  • "amfInfo": [
    ]
}

Access and Mobility Subscription Data Retrieval

retrieve a UE's Access and Mobility Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

Serving PLMN ID or SNPN ID

Array of objects (PlmnId) non-empty

List of PLMNs adjacent to the UE's serving PLMN

disaster-roaming-ind
boolean
Default: false

Indication whether Disaster Roaming service is applied or not

shared-data-ids
Array of strings (SharedDataId) [ items^[0-9]{5,6}-.+$ ]

List of IDs identifying shared Access and Mobility Subscription Data already available at the NF service consumer

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "gpsis": [
    ],
  • "hssGroupId": "string",
  • "internalGroupIds": [
    ],
  • "sharedVnGroupDataIds": {
    },
  • "subscribedUeAmbr": {
    },
  • "nssai": {
    },
  • "ratRestrictions": [
    ],
  • "forbiddenAreas": [
    ],
  • "serviceAreaRestriction": {
    },
  • "coreNetworkTypeRestrictions": [
    ],
  • "accessTypeRestrictions": [
    ],
  • "rfspIndex": 1,
  • "subsRegTimer": 0,
  • "ueUsageType": 0,
  • "mpsPriority": true,
  • "mcsPriority": true,
  • "activeTime": 0,
  • "sorInfo": {
    },
  • "sorInfoExpectInd": true,
  • "sorafRetrieval": false,
  • "sorUpdateIndicatorList": [
    ],
  • "upuInfo": {
    },
  • "routingIndicator": "string",
  • "micoAllowed": true,
  • "sharedAmDataIds": [
    ],
  • "odbPacketServices": "ALL_PACKET_SERVICES",
  • "subscribedDnnList": [
    ],
  • "serviceGapTime": 0,
  • "mdtUserConsent": "CONSENT_NOT_GIVEN",
  • "adjacentPlmnMdtUserConsents": {
    },
  • "mdtConfiguration": {
    },
  • "traceData": {
    },
  • "sharedTraceDataId": "string",
  • "cagData": {
    },
  • "stnSr": "string",
  • "cMsisdn": "string",
  • "nbIoTUePriority": 255,
  • "nssaiInclusionAllowed": false,
  • "rgWirelineCharacteristics": "string",
  • "aun3DeviceConnectivityAllowed": false,
  • "ecRestrictionDataWb": {
    },
  • "ecRestrictionDataNb": false,
  • "expectedUeBehaviourList": {
    },
  • "expectedUeBehaviourData": {
    },
  • "primaryRatRestrictions": [
    ],
  • "secondaryRatRestrictions": [
    ],
  • "edrxParametersList": [
    ],
  • "ptwParametersList": [
    ],
  • "iabOperationAllowed": false,
  • "adjacentPlmnRestrictions": {
    },
  • "wirelineForbiddenAreas": [
    ],
  • "wirelineServiceAreaRestriction": {
    },
  • "pcfSelectionAssistanceInfos": [
    ],
  • "aerialUeSubInfo": {
    },
  • "roamingRestrictions": {
    },
  • "remoteProvInd": false,
  • "3gppChargingCharacteristics": "string",
  • "timeSyncData": {
    },
  • "sharedDataList": [
    ],
  • "qmcConfigInfo": {
    },
  • "mbsrOperationAllowed": {
    },
  • "ncrOperationAllowed": false,
  • "ladnServiceAreas": {
    },
  • "ueLevelMeasurementsConfiguration": {
    }
}

Enhanced Coverage Restriction Data Retrieval

retrieve a UE's subscribed Enhanced Coverage Restriction Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "plmnEcInfoList": [
    ]
}

SMF Selection Subscription Data Retrieval

retrieve a UE's SMF Selection Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

serving PLMN ID or SNPN ID

disaster-roaming-ind
boolean
Default: false

Indication whether Disaster Roaming service is applied or not

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "subscribedSnssaiInfos": {
    },
  • "sharedSnssaiInfosId": "string",
  • "hssGroupId": "string"
}

UE Context In SMF Data Retrieval

retrieve a UE's UE Context In SMF Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "pduSessions": {
    },
  • "pgwInfo": [
    ],
  • "emergencyInfo": {
    }
}

UE Context In SMSF Data Retrieval

retrieve a UE's UE Context In SMSF Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "smsfInfo3GppAccess": {
    },
  • "smsfInfoNon3GppAccess": {
    }
}

Trace Configuration Data Retrieval

retrieve a UE's Trace Configuration Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

serving PLMN ID or SNPN ID

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "traceData": {
    },
  • "sharedTraceDataId": "string"
}

Session Management Subscription Data Retrieval

retrieve a UE's Session Management Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

object (PlmnIdNid)

serving PLMN ID or SNPN ID

disaster-roaming-ind
boolean
Default: false

Indication whether Disaster Roaming service is applied or not

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
Example
[ ]

SMS Subscription Data Retrieval

retrieve a UE's SMS Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

serving PLMN ID or SNPN ID

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "smsSubscribed": true,
  • "sharedSmsSubsDataId": "string",
  • "supportedFeatures": "string"
}

SMS Management Subscription Data Retrieval

retrieve a UE's SMS Management Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

serving PLMN ID or SNPN ID

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "mtSmsSubscribed": true,
  • "mtSmsBarringAll": true,
  • "mtSmsBarringRoaming": true,
  • "moSmsSubscribed": true,
  • "moSmsBarringAll": true,
  • "moSmsBarringRoaming": true,
  • "sharedSmsMngDataIds": [
    ],
  • "traceData": {
    },
  • "sharedTraceDataId": "string"
}

LCS Privacy Data Retrieval

retrieve a UE's LCS Privacy Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "lpi": {
    },
  • "unrelatedClass": {
    },
  • "plmnOperatorClasses": [
    ],
  • "evtRptExpectedArea": {
    },
  • "areaUsageInd": "INSIDE_REPORTING",
  • "upLocRepIndAf": "USER_PLANE_REPORT_NOT_ALLOWED"
}

LCS Mobile Originated Data Retrieval

retrieve a UE's LCS Mobile Originated Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "allowedServiceClasses": [
    ],
  • "moAssistanceDataTypes": {
    }
}

LCS Broadcast Assistance Data Types Retrieval

retrieve a UE's LCS Broadcast Assistance Data Types Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

object (PlmnIdNid)

serving PLMN ID or SNPN ID

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "locationAssistanceType": "string"
}

LCS Subscription Data Retrieval

retrieve a UE's LCS Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "configuredLmfId": "string",
  • "pruInd": "NON_PRU",
  • "lpHapType": "LOW_POW_HIGH_ACCU_POS",
  • "userPlanePosIndLmf": false
}

V2X Subscription Data Retrieval

retrieve a UE's V2X Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "nrV2xServicesAuth": {
    },
  • "lteV2xServicesAuth": {
    },
  • "nrUePc5Ambr": "string",
  • "ltePc5Ambr": "string"
}

Prose Subscription Data Retrieval

retrieve a UE's ProSe Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "proseServiceAuth": {
    },
  • "nrUePc5Ambr": "string",
  • "proseAllowedPlmn": [
    ]
}

5MBS Subscription Data Retrieval

retrieve a UE's 5MBS Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "mbsAllowed": false,
  • "mbsSessionIdList": [
    ],
  • "ueMbsAssistanceInfo": [
    ]
}

Subscription Creation

subscribe to notifications

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

Identity of the user

query Parameters
shared-data-ids
Array of strings (SharedDataId) [ items^[0-9]{5,6}-.+$ ]

List of IDs identifying shared Data already available at and subscribed by the NF service consumer

Request Body schema: application/json
required
nfInstanceId
required
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

implicitUnsubscribe
boolean
expires
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

monitoredResourceUris
required
Array of strings (Uri) non-empty
object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

subscriptionId
string
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

immediateReport
boolean
Default: false
SubscriptionDataSets (object) or Array of SharedData (objects) (ImmediateReport)

Contains the immediate report

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (ContextInfo)

Context Information

nfChangeFilter
boolean
Default: false
uniqueSubscription
boolean
resetIds
Array of strings non-empty
object (UeContextInSmfDataSubFilter)

UE Context In Smf Data Subscription Filter.

Array of objects (PlmnId) non-empty
disasterRoamingInd
boolean
Default: false
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false
object non-empty

A map(list of key-value pairs) where a valid JSON pointer serves as key of expectedUeBehaviourThresholds

Responses

Callbacks

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

Callback payload samples

Callback
Content type
application/json
{
  • "notifyItems": [
    ],
  • "subscriptionId": "string"
}

Subscription Deletion

unsubscribe from notifications

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

Identity of the user

subscriptionId
required
string

Id of the SDM Subscription

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Subscription Modification

modify the subscription

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

Identity of the user

subscriptionId
required
string

Id of the SDM Subscription

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/merge-patch+json
required
expires
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

monitoredResourceUris
Array of strings (Uri) non-empty
object non-empty

A map(list of key-value pairs) where a valid JSON pointer serves as key of expectedUeBehaviourThresholds

Responses

Request samples

Content type
application/merge-patch+json
{
  • "expires": "2019-08-24T14:15:22Z",
  • "monitoredResourceUris": [
    ],
  • "expectedUeBehaviourThresholds": {
    }
}

Response samples

Content type
application/json
Example
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

modify the subscription

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Id of the SDM Subscription

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features required to be supported by the target NF

Request Body schema: application/merge-patch+json
required
expires
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

monitoredResourceUris
Array of strings (Uri) non-empty
object non-empty

A map(list of key-value pairs) where a valid JSON pointer serves as key of expectedUeBehaviourThresholds

Responses

Request samples

Content type
application/merge-patch+json
{
  • "expires": "2019-08-24T14:15:22Z",
  • "monitoredResourceUris": [
    ],
  • "expectedUeBehaviourThresholds": {
    }
}

Response samples

Content type
application/json
Example
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

GPSI to SUPI Translation or SUPI to GPSI translation

retrieve a UE's SUPI or GPSI

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

af-id
string

AF identifier

object (AppPortId)

Application port identifier

af-service-id
string

AF Service Identifier

mtc-provider-info
string (MtcProviderInformation)

MTC Provider Information

string or string (GpsiType)

Requested GPSI Type

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string",
  • "supi": "string",
  • "gpsi": "string",
  • "additionalSupis": [
    ],
  • "additionalGpsis": [
    ]
}

Providing acknowledgement of Steering of Roaming

Nudm_Sdm Info service operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

Request Body schema: application/json
sorMacIue
string (SorMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE).

upuMacIue
string (UpuMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE).

provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

sorTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

ueNotReachable
boolean
Default: false
upuTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

Responses

Request samples

Content type
application/json
{
  • "sorMacIue": "string",
  • "upuMacIue": "string",
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "sorTransparentContainer": "string",
  • "ueNotReachable": false,
  • "upuTransparentContainer": "string"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Providing acknowledgement of UE Parameters Update

Nudm_Sdm Info for UPU service operation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

Request Body schema: application/json
sorMacIue
string (SorMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE).

upuMacIue
string (UpuMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE).

provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

sorTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

ueNotReachable
boolean
Default: false
upuTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

Responses

Request samples

Content type
application/json
{
  • "sorMacIue": "string",
  • "upuMacIue": "string",
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "sorTransparentContainer": "string",
  • "ueNotReachable": false,
  • "upuTransparentContainer": "string"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Providing acknowledgement of S-NSSAIs Update

Nudm_Sdm Info operation for S-NSSAIs acknowledgement

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

Request Body schema: application/json
sorMacIue
string (SorMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE).

upuMacIue
string (UpuMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE).

provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

sorTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

ueNotReachable
boolean
Default: false
upuTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

Responses

Request samples

Content type
application/json
{
  • "sorMacIue": "string",
  • "upuMacIue": "string",
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "sorTransparentContainer": "string",
  • "ueNotReachable": false,
  • "upuTransparentContainer": "string"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Providing acknowledgement of CAG Update

Nudm_Sdm Info operation for CAG acknowledgement

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

Request Body schema: application/json
sorMacIue
string (SorMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE).

upuMacIue
string (UpuMac) ^[A-Fa-f0-9]{32}$

MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE).

provisioningTime
required
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

sorTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

ueNotReachable
boolean
Default: false
upuTransparentContainer
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

Responses

Request samples

Content type
application/json
{
  • "sorMacIue": "string",
  • "upuMacIue": "string",
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "sorTransparentContainer": "string",
  • "ueNotReachable": false,
  • "upuTransparentContainer": "string"
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Trigger SOR info update

Nudm_Sdm custom operation to trigger SOR info update

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

Request Body schema: application/json
required
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Request samples

Content type
application/json
{
  • "vplmnId": {
    },
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "steeringContainer": [
    ],
  • "ackInd": true,
  • "sorMacIausf": "string",
  • "countersor": "string",
  • "provisioningTime": "2019-08-24T14:15:22Z",
  • "sorTransparentContainer": "string",
  • "sorCmci": "string",
  • "sorSnpnSi": "string",
  • "sorSnpnSiLs": "string",
  • "storeSorCmciInMe": true,
  • "usimSupportOfSorCmci": true
}

Retrieval of shared data

retrieve shared data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
query Parameters
shared-data-ids
required
Array of strings (SharedDataIds) non-empty unique [ items^[0-9]{5,6}-.+$ ]

List of shared data ids

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$
Deprecated

Supported Features; this query parameter should not be used

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subscription Creation for shared data

subscribe to notifications for shared data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required
nfInstanceId
required
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

implicitUnsubscribe
boolean
expires
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

callbackReference
required
string (Uri)

String providing an URI formatted according to RFC 3986.

string or string (ServiceName)

Service names known to NRF

monitoredResourceUris
required
Array of strings (Uri) non-empty
object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

subscriptionId
string
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

immediateReport
boolean
Default: false
SubscriptionDataSets (object) or Array of SharedData (objects) (ImmediateReport)

Contains the immediate report

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (ContextInfo)

Context Information

nfChangeFilter
boolean
Default: false
uniqueSubscription
boolean
resetIds
Array of strings non-empty
object (UeContextInSmfDataSubFilter)

UE Context In Smf Data Subscription Filter.

Array of objects (PlmnId) non-empty
disasterRoamingInd
boolean
Default: false
dataRestorationCallbackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

udrRestartInd
boolean
Default: false
object non-empty

A map(list of key-value pairs) where a valid JSON pointer serves as key of expectedUeBehaviourThresholds

Responses

Callbacks

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "implicitUnsubscribe": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "callbackReference": "string",
  • "amfServiceName": "nnrf-nfm",
  • "monitoredResourceUris": [
    ],
  • "singleNssai": {
    },
  • "dnn": "string",
  • "subscriptionId": "string",
  • "plmnId": {
    },
  • "immediateReport": false,
  • "report": {
    },
  • "supportedFeatures": "string",
  • "contextInfo": {
    },
  • "nfChangeFilter": false,
  • "uniqueSubscription": true,
  • "resetIds": [
    ],
  • "ueConSmfDataSubFilter": {
    },
  • "adjacentPlmns": [
    ],
  • "disasterRoamingInd": false,
  • "dataRestorationCallbackUri": "string",
  • "udrRestartInd": false,
  • "expectedUeBehaviourThresholds": {
    }
}

Callback payload samples

Callback
POST: {$request.body#/callbackReference}
Content type
application/json
{
  • "notifyItems": [
    ],
  • "subscriptionId": "string"
}

Subscription Deletion for shared data

unsubscribe from notifications for shared data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Id of the Shared data Subscription

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Group Identifiers

Mapping of Group Identifiers

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
query Parameters
ext-group-id
string (ExtGroupId) ^extgroupid-[^@]+@[^@]+$

External Group Identifier

int-group-id
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

Internal Group Identifier

ue-id-ind
boolean
Default: false

Indication whether UE identifiers are required or not

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

af-id
string

AF identifier

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "extGroupId": "string",
  • "intGroupId": "string",
  • "ueIdList": [
    ]
}

Retrieval of the individual shared data

retrieve the individual shared data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
sharedDataId
required
Array of strings (SharedDataIds) non-empty unique [ items^[0-9]{5,6}-.+$ ]

Id of the Shared data

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "sharedDataId": "string",
  • "sharedAmData": {
    },
  • "sharedSmsSubsData": {
    },
  • "sharedSmsMngSubsData": {
    },
  • "sharedDnnConfigurations": {
    },
  • "sharedTraceData": {
    },
  • "sharedSnssaiInfos": {
    },
  • "sharedVnGroupDatas": {
    },
  • "treatmentInstructions": {
    },
  • "sharedSmSubsData": {
    },
  • "sharedEcsAddrConfigInfo": {
    }
}

Multiple Identifiers

Mapping of UE Identifiers

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

gpsi-list
required
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]

list of the GPSIs

Responses

Response samples

Content type
application/json
{
  • "ueIdList": {
    }
}

Time Sync Subscription Data Retrieval

retrieve a UE's Time Synchronization Subscription Data

Authorizations:
oAuth2ClientCredentialsNone
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "afReqAuthorizations": {
    },
  • "serviceIds": [
    ]
}

A2X Subscription Data Retrieval

retrieve a UE's A2X Subscription Data

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifier of the UE

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

header Parameters
If-None-Match
string

Validator for conditional requests, as described in RFC 9110, 13.1.2

If-Modified-Since
string

Validator for conditional requests, as described in RFC 9110, 13.1.3

Responses

Response samples

Content type
application/json
{
  • "nrA2xServicesAuth": {
    },
  • "lteA2xServicesAuth": {
    },
  • "nrUePc5Ambr": "string",
  • "ltePc5Ambr": "string"
}